Skip to content

chore: drop the TechAPI submodule loop and unused files; document the layout - #134

Merged
Seungpyo1007 merged 9 commits into
mainfrom
chore/repo-cleanup
Nov 11, 2026
Merged

Seungpyo1007 merged 9 commits into
mainfrom
chore/repo-cleanup

Conversation

@TechEngineBot

Copy link
Copy Markdown
Member

What & why

Part of #100. This repo pinned TechAPI as a submodule while TechAPI pins this repo, a loop that nothing used: the gitlink was never initialised, CI checks TechAPI out separately, and the code finds the dataset through app/data_root.py. The pin is gone, so a recursive clone no longer loops.

Changes

  • Submodule: remove the TechAPI gitlink and .gitmodules; ignore /TechAPI/, where CI and local setups place a checkout.
  • Unused files: remove passmark_ids.json, app/verify/baseline.py and app/dump_check.py with its tests. TechAPI checks its own dump with .github/scripts/check_dump.py.
  • integrity_check.py: without a path argument it now reads the directory app.data_root resolves instead of one machine's Windows path.
  • Docs: README gets a Layout section (tree, routes, how the dataset is found, workflows) and no longer mentions weekly crawlers; it also says plainly that the Docker files do not build. docs/DEVELOPMENT.md, CODEOWNERS and the pyproject.toml data URL are corrected. The docs commit from docs/techenginebot-opens-prs is included: TechEngineBot opens PRs by hand and no workflow opens or approves one.
  • Line endings: add .editorconfig and .gitattributes (* text=auto eol=lf). Every tracked text file is already LF, so nothing is renormalised.

Not changed

  • site/ stays: deploy-pages.yml builds and publishes it. Its landing page still mentions a weekly ingest; that is left for a follow-up.
  • The Dockerfile and compose file are described, not repaired.

Checks

  • ruff check app tests passes.
  • pytest tests/unit tests/verify passes locally. mypy and tests/integration are left to CI.

The TechAPI gitlink was never initialised and nothing reads it: workflows
check TechAPI out with actions/checkout and set TECHAPI_DATA_DIR, and
app/data_root.py resolves the dataset from the environment or the parent
directory. TechAPI pins this repo as its submodule, so pinning it back made
a loop that every checkout had to avoid recursing into.

/TechAPI/ is now ignored because CI and local setups still place a checkout
there.
Nothing in the code, tests, workflows or docs of this repo or TechAPI reads
either file. baseline.py rendered a PR-comment table for a workflow that no
longer exists.
No workflow or script calls it. TechAPI checks its own dump with
.github/scripts/check_dump.py, so this copy was only kept alive by four
unit tests, which go with it.
integrity_check.py fell back to one machine's C:\Users path when no
DATA_ROOT was given. It now asks app.data_root, like every other entry
point. The docstring also stops calling the gate weekly, since nothing runs
on a schedule, and the backfill usage examples use ../TechAPI.
README: no weekly crawlers (nothing runs on a schedule), the real /v1
routes, a Layout section that matches the tree, how the engine finds the
dataset, and a Docker note saying the Dockerfile and compose file no longer
build instead of promising a seeded Postgres stack.

DEVELOPMENT.md no longer shows data/ and scripts/ in this repo. pyproject's
Data URL points at GetTechAPI/TechAPI. CODEOWNERS loses a stale TODO and a
/data/ path that does not exist here. Three ingest docstrings stop
mentioning a weekly workflow that opens PRs.
All tracked text is already LF, so the attributes only pin that for
checkouts on Windows; no file is renormalised.
@TechEngineBot TechEngineBot added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 11, 2026
@Seungpyo1007
Seungpyo1007 merged commit ff4e11e into main Nov 11, 2026
5 checks passed
@Seungpyo1007
Seungpyo1007 deleted the chore/repo-cleanup branch November 11, 2026 16:59
@github-project-automation github-project-automation Bot moved this from Todo to Done in TechAPI-Project Nov 11, 2026
Seungpyo1007 added a commit to GetTechAPI/TechAPI that referenced this pull request Nov 11, 2026
This brings in GetTechAPI/TechEngine#134, the engine's own cleanup. The
engine no longer carries TechAPI as a submodule, so the two repos stop
pointing at each other. app/dump_check.py, app/verify/baseline.py and
passmark_ids.json are gone; nothing here called them. integrity_check.py
now reads the directory app.data_root resolves when no path is given,
instead of a Windows path that existed on one machine.

collect.yml's three `uses:` move to the same commit. In the reusable
workflows only a comment changed; the collectors, the validator and the
dump code are untouched.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants